home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / dstat500.zip / DSTAT.TXT < prev    next >
Text File  |  1993-01-08  |  9KB  |  231 lines
  1.                          ======== ======   =======
  2.                             ==    ==   ==     ===
  3.                             ==    ==   ===   ===
  4.                             ==    ==   ==   ===
  5.                             ==    ======   =======
  6.  
  7.                    =======================================
  8.                    The DeAdZoNe Utilities for RemoteAccess
  9.                    =======================================
  10.  
  11.                                      D-StAt
  12.                       Top User Statistics for RemoteAccess
  13.                          Version 5.00   January 8, 1993
  14.                        (C) Copyright Victor Magdic 1991-93
  15.                                All Rights Reserved
  16.  
  17.  
  18. What is it?
  19. -----------
  20.   D-StAt is a program that generates top user bulletins for RemoteAccess
  21.   BBS's.
  22.  
  23.  
  24. Features
  25. --------
  26.    *   Top User Statistics Generator. Provides complete system and user
  27.        information in one easy to use program. Including:
  28.    
  29.              Top Callers, Top (message) Posters, Top Downloaders(in kilobytes
  30.              and files), Top Uploaders (in kilobytes and files), as well as
  31.              totals and Averages.
  32.    
  33.    *   Will use either Handles or Real names.
  34.    *   InfoBar shows you the Total System Calls, Total Downloads,
  35.        Uploads etc., as well as Averages (e.g. Average time used per day etc.)
  36.    *   Can be configured to exclude certain users from the statistics.
  37.    *   Colour of bulletins can be changed if desired (even a 3-d shadow effect
  38.        is available).
  39.    *   Built-in configuration program makes setting up D-StAt a snap!
  40.  
  41.  
  42.  IMPORTANT: D-StAt 5.00 is written for RemoteAccess 1.10/1.11 and will not
  43.             work properly on prior versions of RA.
  44.  
  45.  
  46. How much does it cost?
  47. ----------------------
  48. This utility is FREE!  If you like it you can continue to use it for as long as
  49. you like free of charge!
  50.  
  51. If you do decide to use it, I would be excited to hear from you !!  I encourage
  52. you to send me a postcard at the address listed below (see the end of this text
  53. file), or a message via netmail. It will cost you practically nothing, and will
  54. let me know you're enjoying the program. It will also give me incentive to keep
  55. improving the program and make it even better!
  56.  
  57. Of course donations are graciously accepted <grin> -and if you want to send a
  58. small donation please see the address at the end of this text file.
  59.  
  60.  
  61. Configuration
  62. -------------
  63. To configure D-StAt, type:
  64.  
  65.                DSTAT /C
  66.  
  67. This will bring up the configuration screen. Most of the options are self
  68. explanatory and only a few will be described below:
  69.  
  70.  
  71. TextFiles Directory      Where you want the D-StAt to generate the ANSI and ASCII
  72.                          bulletins.
  73.                          
  74. Path to USERS.BBS        The directory where your user base is kept.
  75.                          
  76. Include Sysop in         If you want the sysop to be included in the door
  77. bulletin                 statistics turn this option on.
  78.                          
  79. Sysop Name in bulletin   If you want the sysop's name included at the top of the
  80. header                   bulletin then turn this option. (Note: the name is use
  81.                          is whatever you have specified under "sysop name".)
  82.                          
  83. Use Handles              Choose YES to use handles when generating the bulletins.
  84.                          Choose NO to use real names.
  85.                          
  86. Generate Bar Graphs      By default D-StAt will generate bar graphs showing the
  87.                          relative values between different users. If you do not
  88.                          want bar graphs, turn this feature off.
  89.                          
  90. Use Percentages in Bar   Turn ON if you want the bar graphs to be accompanied by
  91. Graphs                   percentages.
  92.                          
  93. Honour Hidden Attribute  Turn this ON if you want D-StAt to honour the users
  94.                          hidden attribute as set in their user record. When D-
  95.                          StAt is set to `honour' the hidden attribute, it will
  96.                          not put a user in the bulletins if their hidden
  97.                          attribute is on.
  98.                          
  99. Generate Infobar         The `infobar' is a small bar attached to the bottom o
  100.                          the bulletins which gives you overall system information
  101.                          (e.g. total system calls, total uploads overall etc.)
  102.                          
  103. Use Exclusion File       If you want to use an exclusion file, turn this option
  104.                          on (see discussion on exclusion file later in the docs).
  105.                          
  106. Colour Scheme            Choose the colour scheme for generating the bulletins.1)
  107.                          Yellow/Red2) Cyan/Magenta3) 3-D shadow effect
  108.                          
  109.  
  110.  
  111. Generating Bulletins
  112. --------------------
  113. In order to generate the `Top User' bulletins, run D-StAt with the /G switch,
  114.  
  115.           DSTAT /G
  116.  
  117.   Comments
  118.   --------
  119.    *   D-StAt will handle up to *5000* users in the users file. If this
  120.        number is exceeded D-StAt will abort with an error message.
  121.    *   D-StAt will automatically exclude users who have been locked out i.e.
  122.        security level 0) from the top-user bulletins.
  123.  
  124.  
  125. Exclusion List
  126. --------------
  127. D-StAt supports an exclusion list which allows you to specify up to 100 users
  128. which you do not want included in the bulletins. This is useful if have users
  129. (or co-sysops) which you want to "hide" from the bulletins.
  130.  
  131. In order to use this feature you must create a plain ASCII text file called
  132. DSTAT.CTL and simply list the name or handle of the user which you want excluded
  133. (one entry per line). You must also enable "Exclusion File Checking" in the
  134. configuration menu.
  135.    
  136.    Comments
  137.    --------
  138.    *   It is not necessary to specify both a user's real name and their handle
  139.        as separate entries, one or the other will suffice.
  140.    *   The entries in DSTAT.CTL are *not* case sensitive, so if you have "John
  141.        Smith" in your DSTAT.CTL file, and the user's name is actually spelt
  142.        "JoHn SmItH", the name will still be properly excluded.
  143.    *   If you have more than 100 entries in DSTAT.CTL, D-DooR will tell you so
  144.        and abort with an error message.
  145.    
  146.            Example of DSTAT.CTL:
  147.    
  148.                      John Smith
  149.                      Jane Smith
  150.                      The Punisher
  151.    
  152.  
  153. Location of Files
  154. -----------------
  155. D-StAt can be run from any directory, just make sure you run it from the same
  156. directory where the configuration file (DSTAT.CFG) is located.  Also, the
  157. exclusion file, DSTAT.CTL (if you are using it), must be located in the same
  158. directory that you run DSTAT.EXE from.
  159.  
  160.    Note: D-StAt does *not* write to the RemoteAccess user files at any time.
  161.  
  162.  
  163. Bulletins Created
  164. -----------------
  165. D-StAt creates the following 12 bulletins (6 ANSI and 6 ASCII) in the directory
  166. you have specified as the Textfiles directory:
  167.  
  168.      D_CALL.ANS  and  D_CALL.ASC       top callers
  169.      D_POST.ANS  and  D_POST.ASC       top message posters
  170.      D_UPLK.ANS  and  D_UPLK.ASC       top uploaders by kilobytes
  171.      D_UPLF.ANS  and  D_UPLF.ASC       top uploaders by files
  172.      D_DWLF.ANS  and  D_DWLF.ASC       top downloaders by files
  173.      D_DWLK.ANS  and  D_DWLK.ASC       top downloaders by kilobytes
  174.  
  175.        
  176. Legal Stuff and Disclaimer
  177. --------------------------
  178. "D-StAt" refers to the executables and documentation in the original
  179. distribution archive. D-StAt is copyrighted material by the author, Victor
  180. Magdic. All rights are reserved.  The author grants you a licence to use this
  181. software free of charge.
  182.  
  183. The program is provided "as is", without warranty or guarantee of any kind,
  184. either expressed or implied, as to its quality or performance. The author will
  185. not be held liable to you or anyone for any direct, indirect, incidental or
  186. consequential damages, including but not limited to any lost profits, or lost
  187. savings which may result from the use or inability to use this program.
  188.  
  189. The author is in no way obligated to provide future versions of this software.
  190.  
  191. Your use of the program constitutes your agreement to these terms and to this
  192. disclaimer.
  193.  
  194. All mentioned products are copyrighted by and trademarks of their respective
  195. holders.
  196.  
  197.  
  198. Credits
  199. -------
  200. Thanks to George Cedeno and James FitzGibbon for helping me beta test D-StAt.
  201. And a very special thanks to James for his numerous suggestions and helpful
  202. criticism.
  203.  
  204.  
  205. Updates
  206. -------
  207. Please see the enclosed file DEADZONE.TXT for information on how to obtain the
  208. latest version of D-StAt.
  209.  
  210.        
  211. Suggestions always welcome!
  212. ---------------------------
  213. If you have any suggestions for improvement or wish to report any bugs, you can
  214. reach me via netmail:
  215.        
  216.        The DeAdZoNe
  217.        Victor Magdic
  218.        FidoNet: 1:259/427
  219.        TeleNet Canada: 20:22/104
  220.        
  221.        or by writing to:
  222.        
  223.        Victor Magdic
  224.        424 Camden Circle
  225.        Mississauga, Ontario
  226.        L4Z 2P4
  227.        CANADA
  228.        
  229. ------------------------------------------------------------------ end
  230.  
  231.